rollup-plugin-node-resolve

What is rollup-plugin-node-resolve?

The rollup-plugin-node-resolve package is a Rollup plugin that allows you to use the Node.js resolution algorithm to locate modules using the Node.js module resolution algorithm, which includes resolving modules from node_modules. This is particularly useful for bundling dependencies from npm.

What are rollup-plugin-node-resolve's main functionalities?

Basic Usage

This basic setup demonstrates how to use the rollup-plugin-node-resolve to resolve modules from node_modules in a Rollup configuration.

const resolve = require('@rollup/plugin-node-resolve');

module.exports = {
  input: 'src/index.js',
  output: {
    file: 'bundle.js',
    format: 'cjs'
  },
  plugins: [resolve()]
};

Custom Extensions

This example shows how to configure the plugin to resolve additional file extensions such as .mjs, .json, and .node.

const resolve = require('@rollup/plugin-node-resolve');

module.exports = {
  input: 'src/index.js',
  output: {
    file: 'bundle.js',
    format: 'cjs'
  },
  plugins: [
    resolve({
      extensions: ['.mjs', '.js', '.json', '.node']
    })
  ]
};

Using with CommonJS

This example demonstrates how to use rollup-plugin-node-resolve in conjunction with rollup-plugin-commonjs to bundle CommonJS modules.

const resolve = require('@rollup/plugin-node-resolve');
const commonjs = require('@rollup/plugin-commonjs');

module.exports = {
  input: 'src/index.js',
  output: {
    file: 'bundle.js',
    format: 'cjs'
  },
  plugins: [
    resolve(),
    commonjs()
  ]
};

Other packages similar to rollup-plugin-node-resolve

rollup-plugin-commonjs

The rollup-plugin-commonjs package allows Rollup to convert CommonJS modules to ES6, so they can be included in a Rollup bundle. It is often used together with rollup-plugin-node-resolve to handle npm packages that are written in CommonJS.

rollup-plugin-alias

The rollup-plugin-alias package allows you to define and use custom module aliases in your Rollup configuration. This can be useful for simplifying import paths and managing dependencies more effectively.

rollup-plugin-json

The rollup-plugin-json package allows Rollup to import JSON files, converting them to ES6 modules. This is useful for including configuration files or other data in your bundle.

README

rollup-plugin-node-resolve

This plugin used to be called rollup-plugin-npm

Locate modules using the Node resolution algorithm, for using third party modules in node_modules

Installation

npm install --save-dev rollup-plugin-node-resolve

Usage

// rollup.config.js
import resolve from 'rollup-plugin-node-resolve';

export default {
  input: 'main.js',
  output: {
    file: 'bundle.js',
    format: 'iife'
  },
  name: 'MyModule',
  plugins: [
    resolve({
      // use "module" field for ES6 module if possible
      module: true, // Default: true

      // use "jsnext:main" if possible
      // – see https://github.com/rollup/rollup/wiki/jsnext:main
      jsnext: true,  // Default: false

      // use "main" field or index.js, even if it's not an ES6 module
      // (needs to be converted from CommonJS to ES6
      // – see https://github.com/rollup/rollup-plugin-commonjs
      main: true,  // Default: true

      // some package.json files have a `browser` field which
      // specifies alternative files to load for people bundling
      // for the browser. If that's you, use this option, otherwise
      // pkg.browser will be ignored
      browser: true,  // Default: false

      // not all files you want to resolve are .js files
      extensions: [ '.mjs', '.js', '.jsx', '.json' ],  // Default: [ '.mjs', '.js', '.json', '.node' ]

      // whether to prefer built-in modules (e.g. `fs`, `path`) or
      // local ones with the same names
      preferBuiltins: false,  // Default: true

      // Lock the module search in this path (like a chroot). Module defined
      // outside this path will be marked as external
      jail: '/my/jail/path', // Default: '/'

      // Set to an array of strings and/or regexps to lock the module search
      // to modules that match at least one entry. Modules not matching any
      // entry will be marked as external
      only: [ 'some_module', /^@some_scope\/.*$/ ], // Default: null

      // If true, inspect resolved files to check that they are
      // ES2015 modules
      modulesOnly: true, // Default: false

      // Any additional options that should be passed through
      // to node-resolve
      customResolveOptions: {
        moduleDirectory: 'js_modules'
      }
    })
  ]
};

Using with rollup-plugin-commonjs

Since most packages in your node_modules folder are probably legacy CommonJS rather than JavaScript modules, you may need to use rollup-plugin-commonjs:

// rollup.config.js
import resolve from 'rollup-plugin-node-resolve';
import commonjs from 'rollup-plugin-commonjs';

export default {
  input: 'main.js',
  output: {
    file: 'bundle.js',
    format: 'iife'
  },
  name: 'MyModule',
  plugins: [
    resolve(),
    commonjs()
  ]
};

License

MIT